Skip to main content

message

Message Model​

Represents an individual message exchanged during a conversation, including metadata and role-based context.

id (integer, Read-only)​

Unique identifier for the message.

role (string) Required​

Defines who sent the message.

  • Values: user, assistant, tool, reasoning, builtin_tool

content (string) Required​

The textual content of the message.

  • Minimum length: 1 character

msg_num (integer) Required​

Sequential number of the message in the conversation.

  • Range: -2147483648 to 2147483647

usr_msg_num (string, Read-only)​

Reference to the original user message number for tracking purposes.

fixed (boolean, Read-only)​

Indicates whether the assistant message came from a fixed response.

metadata (object, Nullable)​

Additional metadata associated with the message.

references (array[Reference], Read-only)​

References included in the message, such as citations or links.

files (array[string], Read-only)​

Original file names attached to the message.

metadata_files (object, Read-only)​

Metadata for attached files, keyed by original file name.

created_at (string, Read-only, date-time)​

Timestamp when the message was created.

  • Format: ISO 8601

updated_at (string, Read-only, date-time)​

Timestamp when the message was last updated.

  • Format: ISO 8601

Example​

{
  "id": 0,
  "role": "assistant",
  "content": "string",
  "msg_num": 2147483647,
  "usr_msg_num": "string",
  "fixed": false,
  "metadata": {},
  "references": [],
  "files": [
    "example.pdf"
  ],
  "metadata_files": {
    "example.pdf": {
      "source": "upload"
    }
  },
  "created_at": "2025-05-29T12:51:42.143Z",
  "updated_at": "2025-05-29T12:51:42.143Z"
}